跳到主要内容
版本:V3.0

监听配置API


获取监听配置

接口地址

POST /api/v1.0/invoke/open-ability/method/general-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObjectBody命令参数

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
listen_list[]StringBody监听列表
general_device:通用设备监听通知

请求示例

POST /api/v1.0/invoke/open-ability/method/general-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"listen_list": [
"general_device"
]
}
}

失败返回示例

接口失败返回



开启监听配置

接口地址

POST /api/v1.0/invoke/open-ability/method/general-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
listen_list[]StringBody开启监听列表
general_device:通用设备监听通知

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/general-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "turn_on_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"listen_list": [
"general_device"
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失败返回示例

接口失败返回



关闭监听配置

接口地址

POST /api/v1.0/invoke/open-ability/method/general-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
listen_list[]StringBody关闭监听列表
general_device:通用设备监听通知

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/general-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "turn_off_listen_config",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"listen_list": [
"general_device"
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失败返回示例

接口失败返回